Skip to main content

PolicyCenter Common API (1.11.0)

APIs for common InsuranceSuite platform objects like activities and notes

Complete an Activity

Marks an Activity as completed, setting the status to complete and updating the closeDate and closeUser. Only allowed if the Activity has a status of open, has been assigned to a specific User, and has an activityType of general or approvaldenied.

gw-resourceType: Activity
Authorizations:
basicAuth
path Parameters
activityId
required
string

The id of the Activity

query Parameters
fields
Array of strings
gw-allowForCompositeApi: true

Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form fields=<field list> or fields=<include>:<field list>, where <field list> consists of a comma-separated list of field or field set names. See the documentation for more information.

Request Body schema: application/json

A request body can be sent in order to use the included feature of the request envelope to update or create additional elements when completing the Activity, such as attaching a Note to include details of what was done.

object (ActivityRequestInclusions)

Responses

Request samples

Content type
application/json
{
  • "included": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": {
    }
}
Legal and Support Information
Copyright © 2001-2025 Guidewire Software, Inc.